| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

DepthStencilState.h
1 // DepthStencilState.h
3 //
5
6 namespace nkGraphics
7 {
13 class DepthStencilState : public Resource, public nkExport::Exportable
14 {
15 public :
16
20 virtual ~DepthStencilState () ;
21
25 virtual bool getDepthEnabled () const = 0 ;
29 virtual DEPTH_WRITE_MASK getDepthMasking () const = 0 ;
33 virtual COMPARISON_FUNCTION getDepthComparison() const = 0 ;
34
38 virtual bool getStencilEnabled () const = 0 ;
42 virtual unsigned char getStencilReadMask () const = 0 ;
46 virtual unsigned char getStencilWriteMask () const = 0 ;
50 virtual STENCIL_OP getStencilFailFrontFace () const = 0 ;
54 virtual STENCIL_OP getStencilOkDepthFailFrontFace () const = 0 ;
58 virtual STENCIL_OP getStencilDepthOkFrontFace () const = 0 ;
62 virtual COMPARISON_FUNCTION getStencilComparisonFrontFace () const = 0 ;
66 virtual STENCIL_OP getStencilFailBackFace () const = 0 ;
70 virtual STENCIL_OP getStencilOkDepthFailBackFace () const = 0 ;
74 virtual STENCIL_OP getStencilDepthOkBackFace () const = 0 ;
78 virtual COMPARISON_FUNCTION getStencilComparisonBackFace () const = 0 ;
79
83 virtual void resetToDefault () = 0 ;
84
90 virtual void setDepthEnabled (bool value) = 0 ;
96 virtual void setDepthMasking (DEPTH_WRITE_MASK value) = 0 ;
102 virtual void setDepthComparison (COMPARISON_FUNCTION value) = 0 ;
103
109 virtual void setStencilEnabled (bool value) = 0 ;
115 virtual void setStencilReadMask (unsigned char value) = 0 ;
121 virtual void setStencilWriteMask (unsigned char value) = 0 ;
127 virtual void setStencilFailFrontFace (STENCIL_OP value) = 0 ;
133 virtual void setStencilOkDepthFailFrontFace (STENCIL_OP value) = 0 ;
139 virtual void setStencilDepthOkFrontFace (STENCIL_OP value) = 0 ;
145 virtual void setStencilComparisonFrontFace (COMPARISON_FUNCTION value) = 0 ;
151 virtual void setStencilFailBackFace (STENCIL_OP value) = 0 ;
157 virtual void setStencilOkDepthFailBackFace (STENCIL_OP value) = 0 ;
163 virtual void setStencilDepthOkBackFace (STENCIL_OP value) = 0 ;
169 virtual void setStencilComparisonBackFace (COMPARISON_FUNCTION value) = 0 ;
170
171 // Import / export
172 virtual void exportClassToTree (nkExport::Node* rootNode) ;
173 virtual void importClassFromTree (nkExport::Node* rootNode) ;
174
175 public :
176
177 // Statics
185 static nkMemory::UniquePtr<DepthStencilState> create (System* system = nullptr) ;
186 } ;
187 }
nkGraphics::DepthStencilState::setStencilWriteMask
virtual void setStencilWriteMask(unsigned char value)=0
nkGraphics::DepthStencilState::getStencilFailFrontFace
virtual STENCIL_OP getStencilFailFrontFace() const =0
nkGraphics::DepthStencilState::resetToDefault
virtual void resetToDefault()=0
nkGraphics::DepthStencilState::getStencilComparisonFrontFace
virtual COMPARISON_FUNCTION getStencilComparisonFrontFace() const =0
nkGraphics::DepthStencilState::getStencilReadMask
virtual unsigned char getStencilReadMask() const =0
nkGraphics::DepthStencilState::setStencilOkDepthFailBackFace
virtual void setStencilOkDepthFailBackFace(STENCIL_OP value)=0
nkGraphics::System
Main interface with the component system.
Definition: System.h:14
nkGraphics::DepthStencilState::getDepthMasking
virtual DEPTH_WRITE_MASK getDepthMasking() const =0
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::DepthStencilState::create
static nkMemory::UniquePtr< DepthStencilState > create(System *system=nullptr)
nkGraphics::DepthStencilState::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode)
nkGraphics::DepthStencilState::setStencilDepthOkFrontFace
virtual void setStencilDepthOkFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::setDepthEnabled
virtual void setDepthEnabled(bool value)=0
nkGraphics::DepthStencilState::getStencilFailBackFace
virtual STENCIL_OP getStencilFailBackFace() const =0
nkGraphics::DepthStencilState::getStencilEnabled
virtual bool getStencilEnabled() const =0
nkGraphics::DepthStencilState::setStencilFailBackFace
virtual void setStencilFailBackFace(STENCIL_OP value)=0
nkGraphics::DEPTH_WRITE_MASK
DEPTH_WRITE_MASK
Available depth write masks.
Definition: DxDefinesWrapper.h:124
nkGraphics::DepthStencilState::getStencilComparisonBackFace
virtual COMPARISON_FUNCTION getStencilComparisonBackFace() const =0
nkGraphics::DepthStencilState::getStencilOkDepthFailBackFace
virtual STENCIL_OP getStencilOkDepthFailBackFace() const =0
nkGraphics::DepthStencilState::getDepthEnabled
virtual bool getDepthEnabled() const =0
nkGraphics::DepthStencilState::setStencilComparisonBackFace
virtual void setStencilComparisonBackFace(COMPARISON_FUNCTION value)=0
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::DepthStencilState::setStencilFailFrontFace
virtual void setStencilFailFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::setDepthComparison
virtual void setDepthComparison(COMPARISON_FUNCTION value)=0
nkGraphics::DepthStencilState
Holds information about a depth and stencil state used for rendering.
Definition: DepthStencilState.h:14
nkGraphics::DepthStencilState::setStencilDepthOkBackFace
virtual void setStencilDepthOkBackFace(STENCIL_OP value)=0
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkGraphics::DepthStencilState::getStencilOkDepthFailFrontFace
virtual STENCIL_OP getStencilOkDepthFailFrontFace() const =0
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::DepthStencilState::getStencilDepthOkBackFace
virtual STENCIL_OP getStencilDepthOkBackFace() const =0
nkGraphics::DepthStencilState::setStencilReadMask
virtual void setStencilReadMask(unsigned char value)=0
nkGraphics::DepthStencilState::setStencilOkDepthFailFrontFace
virtual void setStencilOkDepthFailFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::setDepthMasking
virtual void setDepthMasking(DEPTH_WRITE_MASK value)=0
nkGraphics::DepthStencilState::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode)
nkGraphics::DepthStencilState::getStencilWriteMask
virtual unsigned char getStencilWriteMask() const =0
nkGraphics::STENCIL_OP
STENCIL_OP
Available stencil operations.
Definition: DxDefinesWrapper.h:134
nkGraphics::COMPARISON_FUNCTION
COMPARISON_FUNCTION
Available comparison functions available during sampling (for samplers, and depth stencil states).
Definition: ComparisonFunction.h:12
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::DepthStencilState::getStencilDepthOkFrontFace
virtual STENCIL_OP getStencilDepthOkFrontFace() const =0
nkGraphics::DepthStencilState::~DepthStencilState
virtual ~DepthStencilState()
nkGraphics::DepthStencilState::getDepthComparison
virtual COMPARISON_FUNCTION getDepthComparison() const =0
nkGraphics::DepthStencilState::setStencilEnabled
virtual void setStencilEnabled(bool value)=0
nkGraphics::DepthStencilState::setStencilComparisonFrontFace
virtual void setStencilComparisonFrontFace(COMPARISON_FUNCTION value)=0